<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>NumCpp: interp.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">NumCpp
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">A C++ implementation of the Python Numpy library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_functions_2interp_8hpp_source.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">Functions/interp.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_functions_2interp_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_error_8hpp.html">NumCpp/Core/Error.hpp</a>&quot;</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_nd_array_8hpp.html">NumCpp/NdArray.hpp</a>&quot;</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_utils_2interp_8hpp.html">NumCpp/Utils/interp.hpp</a>&quot;</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacenc.html">nc</a></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;{</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="comment">//============================================================================</span></div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"></span>    <span class="keyword">template</span>&lt;<span class="keyword">typename</span> dtype&gt;</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="namespacenc.html#a5b9584eeac344f9d37beb6be475300ca">   49</a></span>&#160;    constexpr <span class="keywordtype">double</span> <a class="code" href="namespacenc.html#a5b9584eeac344f9d37beb6be475300ca">interp</a>(dtype inValue1, dtype inValue2, <span class="keywordtype">double</span> inPercent) noexcept</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    {</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;        <span class="keywordflow">return</span> <a class="code" href="namespacenc_1_1utils.html#a691a52cfcc401340af355bd53869600e">utils::interp</a>(inValue1, inValue2, inPercent);</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    }</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="comment">//============================================================================</span></div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="comment">// Method Description:</span></div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment"></span>    <span class="keyword">template</span>&lt;<span class="keyword">typename</span> dtype&gt;</div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="namespacenc.html#a25a0717dab4a33f74927d390b83182ab">   73</a></span>&#160;    <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a> <a class="code" href="namespacenc.html#a5b9584eeac344f9d37beb6be475300ca">interp</a>(<span class="keyword">const</span> <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a>&amp; inX, <span class="keyword">const</span> <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a>&amp; inXp, <span class="keyword">const</span> <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a>&amp; inFp)</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    {</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;        <span class="comment">// do some error checking first</span></div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;        <span class="keywordflow">if</span> (inXp.<a class="code" href="classnc_1_1_nd_array.html#a6871de7968fa26f32d9c43167cd66131">size</a>() != inFp.<a class="code" href="classnc_1_1_nd_array.html#a6871de7968fa26f32d9c43167cd66131">size</a>())</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;        {</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;            <a class="code" href="_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd">THROW_INVALID_ARGUMENT_ERROR</a>(<span class="stringliteral">&quot;inXp and inFp need to be the same size().&quot;</span>);</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;        }</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;        <span class="keywordflow">if</span> (inX.<a class="code" href="classnc_1_1_nd_array.html#a7a863a1318f753addcf8163191085061">min</a>().item() &lt; inXp.<a class="code" href="classnc_1_1_nd_array.html#a7a863a1318f753addcf8163191085061">min</a>().item() || inX.<a class="code" href="classnc_1_1_nd_array.html#a1da78e30bcb54c80c887b454a2342d42">max</a>().item() &gt; inXp.<a class="code" href="classnc_1_1_nd_array.html#a1da78e30bcb54c80c887b454a2342d42">max</a>().item())</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;        {</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;            <a class="code" href="_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd">THROW_INVALID_ARGUMENT_ERROR</a>(<span class="stringliteral">&quot;endpoints of inX should be contained within inXp.&quot;</span>);</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;        }</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;        <span class="comment">// sort the input inXp and inFp data</span></div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;        <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;uint32&gt;</a> sortedXpIdxs = <a class="code" href="namespacenc.html#ad5510f8aa54a5ed677e82fbe2c378b84">argsort</a>(inXp);</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;        <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a> sortedXp(1, inFp.<a class="code" href="classnc_1_1_nd_array.html#a6871de7968fa26f32d9c43167cd66131">size</a>());</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;        <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a> sortedFp(1, inFp.<a class="code" href="classnc_1_1_nd_array.html#a6871de7968fa26f32d9c43167cd66131">size</a>());</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;        <a class="code" href="namespacenc.html#aacba4d66f94f6f53637e23c5d82e20d8">uint32</a> counter = 0;</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;        <span class="keywordflow">for</span> (<span class="keyword">auto</span> sortedXpIdx : sortedXpIdxs)</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;        {</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;            sortedXp[counter] = inXp[sortedXpIdx];</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;            sortedFp[counter++] = inFp[sortedXpIdx];</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;        }</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;        <span class="comment">// sort the input inX array</span></div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;        <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a> sortedX = <a class="code" href="namespacenc.html#a31771e9950ef3c2aba7582700de304dd">sort</a>(inX);</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;        <a class="code" href="classnc_1_1_nd_array.html">NdArray&lt;dtype&gt;</a> returnArray(1, inX.<a class="code" href="classnc_1_1_nd_array.html#a6871de7968fa26f32d9c43167cd66131">size</a>());</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;        <a class="code" href="namespacenc.html#aacba4d66f94f6f53637e23c5d82e20d8">uint32</a> currXpIdx = 0;</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;        <a class="code" href="namespacenc.html#aacba4d66f94f6f53637e23c5d82e20d8">uint32</a> currXidx = 0;</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;        <span class="keywordflow">while</span> (currXidx &lt; sortedX.<a class="code" href="classnc_1_1_nd_array.html#a6871de7968fa26f32d9c43167cd66131">size</a>())</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;        {</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;            <span class="keywordflow">if</span> (sortedXp[currXpIdx] &lt;= sortedX[currXidx] &amp;&amp; sortedX[currXidx] &lt;= sortedXp[currXpIdx + 1])</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;            {</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;                <span class="keyword">const</span> <span class="keywordtype">double</span> percent = <span class="keyword">static_cast&lt;</span><span class="keywordtype">double</span><span class="keyword">&gt;</span>(sortedX[currXidx] - sortedXp[currXpIdx]) /</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;                    static_cast&lt;double&gt;(sortedXp[currXpIdx + 1] - sortedXp[currXpIdx]);</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;                returnArray[currXidx++] = <a class="code" href="namespacenc_1_1utils.html#a691a52cfcc401340af355bd53869600e">utils::interp</a>(sortedFp[currXpIdx], sortedFp[currXpIdx + 1], percent);</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;            }</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;            <span class="keywordflow">else</span></div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;            {</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;                ++currXpIdx;</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;            }</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;        }</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;        <span class="keywordflow">return</span> returnArray;</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;    }</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;}</div><div class="ttc" id="_error_8hpp_html"><div class="ttname"><a href="_error_8hpp.html">Error.hpp</a></div></div>
<div class="ttc" id="namespacenc_html"><div class="ttname"><a href="namespacenc.html">nc</a></div><div class="ttdef"><b>Definition:</b> Coordinate.hpp:45</div></div>
<div class="ttc" id="namespacenc_html_aacba4d66f94f6f53637e23c5d82e20d8"><div class="ttname"><a href="namespacenc.html#aacba4d66f94f6f53637e23c5d82e20d8">nc::uint32</a></div><div class="ttdeci">uint32_t uint32</div><div class="ttdef"><b>Definition:</b> Types.hpp:41</div></div>
<div class="ttc" id="classnc_1_1_nd_array_html_a1da78e30bcb54c80c887b454a2342d42"><div class="ttname"><a href="classnc_1_1_nd_array.html#a1da78e30bcb54c80c887b454a2342d42">nc::NdArray::max</a></div><div class="ttdeci">NdArray&lt; dtype &gt; max(Axis inAxis=Axis::NONE) const noexcept</div><div class="ttdef"><b>Definition:</b> NdArrayCore.hpp:2124</div></div>
<div class="ttc" id="_nd_array_8hpp_html"><div class="ttname"><a href="_nd_array_8hpp.html">NdArray.hpp</a></div></div>
<div class="ttc" id="_utils_2interp_8hpp_html"><div class="ttname"><a href="_utils_2interp_8hpp.html">interp.hpp</a></div></div>
<div class="ttc" id="namespacenc_html_ad5510f8aa54a5ed677e82fbe2c378b84"><div class="ttname"><a href="namespacenc.html#ad5510f8aa54a5ed677e82fbe2c378b84">nc::argsort</a></div><div class="ttdeci">NdArray&lt; uint32 &gt; argsort(const NdArray&lt; dtype &gt; &amp;inArray, Axis inAxis=Axis::NONE) noexcept</div><div class="ttdef"><b>Definition:</b> argsort.hpp:48</div></div>
<div class="ttc" id="namespacenc_html_a31771e9950ef3c2aba7582700de304dd"><div class="ttname"><a href="namespacenc.html#a31771e9950ef3c2aba7582700de304dd">nc::sort</a></div><div class="ttdeci">NdArray&lt; dtype &gt; sort(const NdArray&lt; dtype &gt; &amp;inArray, Axis inAxis=Axis::NONE) noexcept</div><div class="ttdef"><b>Definition:</b> sort.hpp:48</div></div>
<div class="ttc" id="classnc_1_1_nd_array_html_a7a863a1318f753addcf8163191085061"><div class="ttname"><a href="classnc_1_1_nd_array.html#a7a863a1318f753addcf8163191085061">nc::NdArray::min</a></div><div class="ttdeci">NdArray&lt; dtype &gt; min(Axis inAxis=Axis::NONE) const noexcept</div><div class="ttdef"><b>Definition:</b> NdArrayCore.hpp:2174</div></div>
<div class="ttc" id="_error_8hpp_html_af2aff1172060367b9c5398fa097fa8fd"><div class="ttname"><a href="_error_8hpp.html#af2aff1172060367b9c5398fa097fa8fd">THROW_INVALID_ARGUMENT_ERROR</a></div><div class="ttdeci">#define THROW_INVALID_ARGUMENT_ERROR(msg)</div><div class="ttdef"><b>Definition:</b> Error.hpp:38</div></div>
<div class="ttc" id="namespacenc_html_a5b9584eeac344f9d37beb6be475300ca"><div class="ttname"><a href="namespacenc.html#a5b9584eeac344f9d37beb6be475300ca">nc::interp</a></div><div class="ttdeci">constexpr double interp(dtype inValue1, dtype inValue2, double inPercent) noexcept</div><div class="ttdef"><b>Definition:</b> Functions/interp.hpp:49</div></div>
<div class="ttc" id="namespacenc_1_1utils_html_a691a52cfcc401340af355bd53869600e"><div class="ttname"><a href="namespacenc_1_1utils.html#a691a52cfcc401340af355bd53869600e">nc::utils::interp</a></div><div class="ttdeci">constexpr double interp(double inValue1, double inValue2, double inPercent) noexcept</div><div class="ttdef"><b>Definition:</b> Utils/interp.hpp:44</div></div>
<div class="ttc" id="classnc_1_1_nd_array_html_a6871de7968fa26f32d9c43167cd66131"><div class="ttname"><a href="classnc_1_1_nd_array.html#a6871de7968fa26f32d9c43167cd66131">nc::NdArray::size</a></div><div class="ttdeci">uint32 size() const noexcept</div><div class="ttdef"><b>Definition:</b> NdArrayCore.hpp:3614</div></div>
<div class="ttc" id="classnc_1_1_nd_array_html"><div class="ttname"><a href="classnc_1_1_nd_array.html">nc::NdArray</a></div><div class="ttdoc">Holds 1D and 2D arrays, the main work horse of the NumCpp library. </div><div class="ttdef"><b>Definition:</b> NdArrayCore.hpp:66</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_34171bd951b13a53aa9f237277a18e40.html">NumCpp</a></li><li class="navelem"><a class="el" href="dir_9051d82ec7b39b1c992f5bf2868571ca.html">Functions</a></li><li class="navelem"><a class="el" href="_functions_2interp_8hpp.html">interp.hpp</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
  </ul>
</div>
</body>
</html>
